home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 June: Reference Library / Dev.CD Jun 99 RL Disk 2.toast / Technical Publications / webobjects / WebObjects_3.5 / Reference / ClientSideComponents / SupportClasses / next.util.PropertyListUtilities < prev    next >
Encoding:
Text File  |  1998-04-07  |  5.2 KB  |  183 lines  |  [TEXT/R*ch]
  1. <!--NewPage-->
  2.  
  3. <html>
  4.  
  5. <head>
  6.  
  7. <!-- Generated by javadoc on Mon Oct 21 18:15:47  1996 -->
  8.  
  9. <a name="_top_"></a>
  10.  
  11. <title>
  12.  
  13.   Class next.util.PropertyListUtilities
  14.  
  15. </title>
  16.  
  17. </head>
  18.  
  19. <body bgcolor=#FFFFFF>
  20.  
  21. <pre>
  22.  
  23. <a href="Package-next.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-next.util.html">This Package</a>  <a href="Package-next.util.html">Previous</a>  <a href="Package-next.util.html">Next</a> </pre>
  24.  
  25. <hr>
  26.  
  27. <h1>
  28.  
  29.   Class next.util.PropertyListUtilities
  30.  
  31. </h1>
  32.  
  33. <pre>
  34.  
  35. <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">java.lang.Object</a>
  36.  
  37.    |
  38.  
  39.    +----next.util.PropertyListUtilities
  40.  
  41. </pre>
  42.  
  43. <hr>
  44.  
  45. <dl>
  46.  
  47.   <dt> public class <b>PropertyListUtilities</b>
  48.  
  49.   <dt> extends <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">Object</a>
  50.  
  51. </dl>
  52.  
  53. The PropertyListUtilities class provides a collection of utility 
  54.  
  55. methods that deal with property lists. One method, <b>propertyListFromString(</b>String<b>)</b> 
  56.  
  57. converts string objects containing ASCII encoded property lists to 
  58.  
  59. property-list objects. Another method, <b>stringFromPropertyList(</b>Object<b>)</b> 
  60.  
  61. does the opposite conversion, and the third <b>propertyListsAreEqual(</b>Object, Object<b>)</b>
  62.  
  63. compares property-list objects. These methods are useful for serializing and deserializing property lists in and out of string objects.
  64.  
  65. <dl>
  66.  
  67.     <dt> <b>See Also:</b>
  68.  
  69.     <dd> <a href="next.util.KeyValueCoding.html#_top_">KeyValueCoding</a>
  70.  
  71. </dl>
  72.  
  73. <hr>
  74.  
  75. <a name="index"></a>
  76.  
  77. <h2>
  78.  
  79.   <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
  80.  
  81. </h2>
  82.  
  83. <dl>
  84.  
  85.   <dt> <img src="images/green-ball-small.gif" width=6 height=6 alt=" o ">
  86.  
  87.     <a href="#propertyListFromString(java.lang.String)"><b>propertyListFromString</b></a>(String)
  88.  
  89.   <dd> Returns a property-list object derived from interpreting the ASCII property-list representation <i>stringRep</i>.
  90.  
  91.   <dt> <img src="images/green-ball-small.gif" width=6 height=6 alt=" o ">
  92.  
  93.     <a href="#propertyListsAreEqual(java.lang.Object, java.lang.Object)"><b>propertyListsAreEqual</b></a>(Object, Object)
  94.  
  95.   <dd> Returns TRUE if <i>plist1</i> and <i>plist2</i> are the same, FALSE if they are not.
  96.  
  97.   <dt> <img src="images/green-ball-small.gif" width=6 height=6 alt=" o ">
  98.  
  99.     <a href="#stringFromPropertyList(java.lang.Object)"><b>stringFromPropertyList</b></a>(Object)
  100.  
  101.   <dd> Returns a string object, which has only characters from the ASCII subset of Unicode.
  102.  
  103. </dl>
  104.  
  105.  
  106.  
  107. <a name="methods"></a>
  108.  
  109. <h2>
  110.  
  111.   <img src="images/methods.gif" width=151 height=38 alt="Methods">
  112.  
  113. </h2>
  114.  
  115. <a name="stringFromPropertyList(java.lang.Object)"><img src="images/green-ball.gif" width=12 height=12 alt=" o "></a>
  116.  
  117. <a name="stringFromPropertyList"><b>stringFromPropertyList</b></a>
  118.  
  119. <pre>
  120.  
  121.   public static <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.String.html#_top_">String</a> stringFromPropertyList(<a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">Object</a> plist)
  122.  
  123. </pre>
  124.  
  125. <dl>
  126.  
  127.   <dd> Returns a string object, which has only characters from the ASCII subset of Unicode. The <i>plist</i> object must be one of the other permitted property-list types: Vector, Hashtable, or byte[].
  128.  
  129. </dl>
  130.  
  131. <a name="propertyListFromString(java.lang.String)"><img src="images/green-ball.gif" width=12 height=12 alt=" o "></a>
  132.  
  133. <a name="propertyListFromString"><b>propertyListFromString</b></a>
  134.  
  135. <pre>
  136.  
  137.   public static <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">Object</a> propertyListFromString(<a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.String.html#_top_">String</a> stringRep)
  138.  
  139. </pre>
  140.  
  141. <dl>
  142.  
  143.   <dd> Returns a property-list object derived from interpreting the ASCII property-list representation <i>stringRep</i>. The string object should encode only one top-level object. The return object is one of Vector, Hashtable, String, or byte[].
  144.  
  145.   <dl>
  146.  
  147.     <dt> <b>Throws:</b> <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.RuntimeException.html#_top_">RuntimeException</a>
  148.  
  149.     <dd> Throws a RuntimeException if there is an error parsing the property-list representation.
  150.  
  151.   </dl>
  152.  
  153. </dl>
  154.  
  155. <a name="propertyListsAreEqual(java.lang.Object, java.lang.Object)"><img src="images/green-ball.gif" width=12 height=12 alt=" o "></a>
  156.  
  157. <a name="propertyListsAreEqual"><b>propertyListsAreEqual</b></a>
  158.  
  159. <pre>
  160.  
  161.   public static boolean propertyListsAreEqual(<a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">Object</a> plist1,
  162.  
  163.                                               <a href="http://www.javasoft.com/products/JDK/1.0.2/api/java.lang.Object.html#_top_">Object</a> plist2)
  164.  
  165. </pre>
  166.  
  167. <dl>
  168.  
  169.   <dd> Returns TRUE if <i>plist1</i> and <i>plist2</i> are the same, FALSE if they are not. The compared objects must be of the same type (else FALSE is always returned). This method performs recursive compare operations on collections such as Vectors and Hastables. If anything is different, the method returns FALSE.
  170.  
  171. </dl>
  172.  
  173. <hr>
  174.  
  175. <pre>
  176.  
  177. <a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-next.util.html">This Package</a>  <a href="Package-next.util.html">Previous</a>  <a href="Package-next.util.html">Next</a> </pre>
  178.  
  179. </body>
  180.  
  181. </html>
  182.  
  183.